Hybris Sales UX API

(0 reviews)

Fetch Stores - TMF673 GET geograhicAddress

This API is used to retrieves details of all stores including delivery availability, pickup options, and address information.

URL

http://[localhost]:[port]/ecom-sales-ux/v1/{businessId}/geographicAddress

url Param

name	type	description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, PR, etc.) identifying the business unit.	Y

name	type	description	required
client_id	string	The client_id identifying the channel.	Y
client_secret	string	Password associated with the client_id.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

Query Param

name	type	description	required
filter	string	Filter parameter to indicate LibertyStore. Expected value is "LibertyStore" for PR market	Y

cURL request

curl --location 'https://nonprod.esb.cloud.lla.com/dev/ecom-sales-ux/ecom-sales-ux/v1/PR/geographicAddress?filter='LibertyStore' \
--header 'client_id: abcd1234' \
--header 'client_secret: abc123' \
--header 'X-Correlation-ID: 1234567UYTRE456J' \

Response

[
    {
        "id": "18PR",     //storeId
        "name": "Metro Store",     //storeName
        "city": "GUAYNABO",     //storeAddress.city
        "country": "USA",     //storeAddress.country
        "postcode": "00966",     //storeAddress.zipcode
        "stateOrProvince": "PR",     //storeAddress.state
        "streetName": "103 AVE ORTEGON",     //storeAddress.streetAddress
        "characteristic": [
            {
                "name": "isLibertyDeliversAvailable",
                "valueType": "boolean",
                "value": true
            },
            {
                "name": "isLibertyPickupAvailable",
                "valueType": "boolean",
                "value": true
            },
            {
                "name": "libertyDeliversZipCodes",
                "valueType": "string",
                "value": "00624,00645"
            },
            {
                "name": "deviceThreshold",
                "valueType": "string",
                "value": "5"
            }
        ]
    }
]

Definitions

Each of the request parameters is detailed.

name	type	description	required
id	string	Unique identifier for the store	Y
name	string	Name of the store	Y
city	string	City where the store is located	Y
country	string	Country	Y
postcode	string	ZIP code of the store	Y
stateOrProvince	string	State abbreviation	Y
streetName	string	Street address of the store	Y
characteristic	array	List of characteristics	N
characteristic.name	string	Name of the characteristics	N
characteristic.value	any	Value of the characteristics	N
characteristic.valueType	string	Value type of the characteristics	N

Note: For SYS layers it's necessary to define the elements present in characteristic[] resources

characteristic name	type	description
isLibertyDeliversAvailable	boolean	Indicates if Liberty delivery service is available
isLibertyPickupAvailable	boolean	Indicates if Liberty pickup service is available
libertyDeliversZipCodes	string	ZIP code(s) where Liberty delivers
deviceThreshold	string	device threshold set for the store

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The request resource could not be found.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method DELETE not allowed for : /{businessId}/geographicAddress"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error"
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation GET /geographicAddress for Business Id: xxxx not implemented"
    }]
  }

Reviews